vcSelectionManager
vcSelectionManager is responsible for handling the types of selections used by the application.
See in: Overview
Module: vcCore
Parent: -
Children -
Referenced by: vcApplication.SelectionManager
Methods
Learn how to use methods here. The methods are also inherited from the parent class.
| Name | Return Type | Parameters | Description |
| clear | None | None | Removes all objects from selection. |
| getSelection | vcList | None | Returns all currently selected objects.See moreSome selectable objects don't have a corresponding class in the Python API and thus aren't included. Returns: List[vcObject]: The selected objects. Empty list if none. |
| getSelection | vcList | type type | Returns currently selected objects of given type.See moreThe type filtering works like the Python isinstance(obj, type) function. It considers class inheritance. Parameters: type (Type): A Python class derived from vcObject such as vcComponent. Returns: List[vcObject]: The selected objects. Empty list if none. |
| setSelection | None | vcObject object, Optional Keyword[append = Boolean] | Either replaces the current selection or appends to it.See moreParameters: object (vcObject): Object to select. append (bool): When True, the object is added to current selection. Exceptions: ValueError: When the object has been deleted. RuntimeError: When the object can't be selected. |
| setSelection | None | list objects, Optional Keyword[append = Boolean] | Either replaces the current selection or appends to it.See moreParameters: objects (List[vcObject]): Objects to select. append (bool): When True, the objects are added to current selection. Exceptions: ValueError: When any of the objects have been deleted. RuntimeError: When any of the objects can't be selected. |
Events
Learn how to use events here. The events are also inherited from the parent class.
| Name | Parameters | Description |
| OnSelectionChanged | None | Event triggered when selection has changed. |